Skip to main content

List Backups

This API returns a list of backups available within the system, including both manual and automatic backups.

Endpoint Details

URL/v1/backup/list
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Response

Here is an example of a response when viewing a list of data:

Response
{
"data": [
{
"id": "bc77050a-7fa1-4af8-8a0c-e5d9b0bc3e25",
"file_name": "dummy 2",
"status": 3,
"scopes": [
1,
2
],
"destination_type": 1,
"destination_path": "/tmp/backups/dummy 2.tar.gz.enc",
"file_size": 1325201,
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by_name": "Admin Aplikasi",
"created_at": 1784776205,
"completed_at": 1784776205
},
{
"id": "f614f86f-3011-4ba7-99cc-db0ba9632c0e",
"file_name": "dummy",
"status": 3,
"scopes": [
1,
2
],
"destination_type": 1,
"destination_path": "/tmp/backups/dummy.tar.gz.enc",
"file_size": 1325876,
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by_name": "Admin Aplikasi",
"created_at": 1784775679,
"completed_at": 1784775681
},
{
"id": "f5316dfe-52a1-4289-8d13-9fdc81d3e11b",
"file_name": "testing 5",
"status": 3,
"scopes": [
1,
2
],
"destination_type": 1,
"destination_path": "/tmp/backups/testing 5.tar.gz.enc",
"file_size": 1318344,
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by_name": "Admin Aplikasi",
"created_at": 1784707403,
"completed_at": 1784707405
},
{
"id": "8dee09ba-05e0-4572-9931-baa618e2bec4",
"file_name": "auto-backup-20260722-100000",
"description": "Automatic backup",
"status": 3,
"scopes": [
1,
2,
3,
4
],
"destination_type": 1,
"destination_path": "/tmp/takakrypt/backups/auto-backup-20260722-100000.tar.gz.enc",
"file_size": 1311341,
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by_name": "Admin Aplikasi",
"created_at": 1784689200,
"completed_at": 1784689280,
"is_automatic": true
}
],
"pagination": {
"total": 4,
"page": 1,
"page_size": 20,
"last_page": 1
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the backup
file_nameStringName of the backup file
descriptionStringDescription of the backup
statusIntegerCurrent status code of the backup
scopesArrayList of scope codes included in the backup
destination_typeIntegerType of backup destination
destination_pathStringPath where the backup file is stored
file_sizeIntegerSize of the backup file in bytes
created_byUUIDIdentifier of the user who created the backup
created_by_nameStringDisplay name of the user who created the backup
created_atIntegerCreation timestamp in Unix format
completed_atIntegerCompletion timestamp in Unix format
is_automaticBooleanIndicates whether the backup was created automatically
totalIntegerTotal number of backups available
pageIntegerCurrent page number
page_sizeIntegerNumber of records returned per page
last_pageIntegerTotal number of available pages

info
  • A valid Bearer Token is required to access this endpoint.
  • The response includes both manual and automatic backups. Automatic backups are marked with is_automatic: true.
  • The scopes array uses the following codes:
    • 1 = System Configuration
    • 2 = Keys
    • 3 = Audit Log
    • 4 = System Log
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.